Hybris Sales UX API
List Questions - Assurant
Returns the list of questions and answers used to triage the devices before sending an offer creation.
URL
https://[localhost]:[port]/ecom-sales-ux/v1/{businessId}/questionsurl Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
Header
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
cURL request
curl --location 'https://nonprod.esb.cloud.lla.com/dev/ecom-sales-ux/ecom-sales-ux/v1/PR/questions' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'client_id: abcde' \
--header 'client_secret: 12345'Response
[
{
"name": "01_POWERON_LCTI",
"resourceCharacteristic": [
{
"name": "languages",
"value": [
{
"text": "Does the Device Power On and Off?",
"language": "ENGLISH",
"answers": [
{
"name": "POWERON_NO",
"text": "No",
"defect": ""
},
{
"name": "POWERON_YES",
"text": "Yes",
"defect": ""
}
]
},
{
"text": "¿El dispositivo se enciende?",
"language": "SPANISH",
"answers": [
{
"name": "POWERON_NO",
"text": "No",
"defect": ""
},
{
"name": "POWERON_YES",
"text": "Si",
"defect": ""
}
]
}
]
}
]
},
{
"name": "02_THEFT_DISABLED_LCTI",
"resourceCharacteristic": [
{
"name": "languages",
"value": [
{
"text": "Is the Activation Lock turned off? (e.g. Find My iPhone or Reactivation Lock)",
"language": "ENGLISH",
"answers": [
{
"name": "THEFTDIS_NO",
"text": "No",
"defect": ""
},
{
"name": "THEFTDIS_YES",
"text": "Yes",
"defect": ""
}
]
},
{
"text": "¿Has desactivado la funcion antirrobo en tu dispositivo?",
"language": "SPANISH",
"answers": [
{
"name": "THEFTDIS_NO",
"text": "No",
"defect": ""
},
{
"name": "THEFTDIS_YES",
"text": "Si",
"defect": ""
}
]
}
]
}
]
},
{
"name": "03_LCDOK_LCTI",
"resourceCharacteristic": [
{
"name": "languages",
"value": [
{
"text": "Is the display screen free of cracks and does not have any screen damage?",
"language": "ENGLISH",
"answers": [
{
"name": "LCDOK_NO",
"text": "No",
"defect": ""
},
{
"name": "LCDOK_YES",
"text": "Yes",
"defect": ""
}
]
},
{
"text": "¿Tiene el dispositivo una pantalla funcional libre de grietas y otros daños?",
"language": "SPANISH",
"answers": [
{
"name": "LCDOK_NO",
"text": "No",
"defect": ""
},
{
"name": "LCDOK_YES",
"text": "Si",
"defect": ""
}
]
}
]
}
]
},
{
"name": "04_DAMFREE_LCTI",
"resourceCharacteristic": [
{
"name": "languages",
"value": [
{
"text": "Is the device free of physical damage?",
"language": "ENGLISH",
"answers": [
{
"name": "DAMFREE_NO",
"text": "No",
"defect": ""
},
{
"name": "DAMFREE_YES",
"text": "Yes",
"defect": ""
}
]
},
{
"text": "¿El dispositivo está libre de daños fÃsicos o modificaciones?",
"language": "SPANISH",
"answers": [
{
"name": "DAMFREE_NO",
"text": "No",
"defect": ""
},
{
"name": "DAMFREE_YES",
"text": "Si",
"defect": ""
}
]
}
]
}
]
}
]Definitions
| name | type | description | required |
|---|---|---|---|
| name | string | Name to identify the triage question | Y |
| resourceCharacteristic | array | A list of characteristics | Y |
| resourceCharacteristic[].name | string | Name of characteristic. Wording and answers in every supported language | Y |
| resourceCharacteristic[].value | array | Value of characteristic | Y |
| resourceCharacteristic[].value[].text | string | Wording to be presented to the customer | Y |
| resourceCharacteristic[].value[].language | string | Language of the wording | Y |
| resourceCharacteristic[].value[].answers | array | A List of possible answers for the question | Y |
| resourceCharacteristic[].value[].answers[].name | string | Name that identifies the answer for a question | Y |
| resourceCharacteristic[].value[].answers[].text | string | Wording of the answer in the specific language | Y |
| resourceCharacteristic[].value[].answers[].defect | string | Contains the defect associated with this answer. Eg: DISPLAY_PROBLEM, LIQUID_DAMAGE, POWER_ON, FMIP | Y |
Possible response error
In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.
[ 400 ]
Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
{
"errors" : [{
"code" : 400,
"message" : "The request is invalid or not properly formed.",
"description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
}]
}[ 401 ]
Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.
{
"errors" : [{
"code" : 401,
"message" : "The user could not be authenticated for this request.",
"description" : "The request has not been applied because it lacks valid authentication credentials for the target resource."
}]
}[ 404 ]
Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.
{
"errors" : [{
"code" : 404,
"message" : "The server could not find the requested resource.",
"description" : "The requested operation failed because a resource associated with the request could not be found."
}]
}[ 405 ]
Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
{
"errors": [{
"code": 405,
"message": "APIKIT:METHOD_NOT_ALLOWED",
"description": "HTTP Method POST not allowed for : /questions"
}]
}[ 500 ]
Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.
{
"errors" : [{
"code" : 500,
"message" : "Internal Server Error",
"description": "The request failed due to an internal error."
}]
}[ 501 ]
Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.
{
"errors" : [{
"code" : 501,
"message" : "Not implemented",
"description" : "Operation GET /questions for Business Id: xxxx not implemented"
}]
}